Skip to content

docs(managed-postgres): document slow query patterns API#131

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/71f1e99b
Open

docs(managed-postgres): document slow query patterns API#131
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/71f1e99b

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Jun 5, 2026

Summary

Ports ClickHouse/clickhouse-docs#6330 — documents the two new Postgres slow query pattern endpoints and cross-links the Query Insights monitoring page with the OpenAPI reference.

Changes

  • products/managed-postgres/openapi.mdx — added a Query insights section with curl examples for slowQueryPatternsGetList (with from_date / to_date, sort_by, filters, paging) and slowQueryPatternGet (required db_name, db_user, db_operation), sample JSON responses, and new link references. Updated frontmatter keywords.
  • products/managed-postgres/monitoring/query-insights.mdx — added a Query insights API section mapping the Slow patterns table and detail flyout to their API endpoints, plus a Related pages link to the OpenAPI page.

Notes / ambiguity

  • Swagger links use the Mintlify API reference path (/api-reference/organization/get-list-of-available-organizations#tag/Postgres/...) rather than the external clickhouse.com/docs/cloud/manage/api/swagger URL used in the Docusaurus source, matching the existing convention in openapi.mdx.
  • The Mintlify openapi.mdx already diverged from the Docusaurus source (uncommented Organization ID section, storageSize retained in the create example, different id example, etc.). Only the strictly additive PR content (the Query insights API section + link refs + keywords) was ported; pre-existing differences were left alone.

Note

Low Risk
Documentation-only changes with no runtime, auth, or data-path impact.

Overview
Documents the Managed Postgres slow query pattern OpenAPI endpoints and ties them to the existing Query Insights console docs.

openapi.mdx adds a Query insights section with curl examples for listing patterns (from_date/to_date, sort_by, filters, paging) and fetching one pattern by queryId (required db_name, db_user, db_operation), plus sample JSON and Mintlify API reference links. Frontmatter keywords now include query insights / slow queries.

query-insights.mdx adds a Query insights API section mapping the Slow patterns table and detail flyout to those endpoints, and a Related pages link back to OpenAPI.

Reviewed by Cursor Bugbot for commit 4fd09e0. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview Jun 5, 2026, 1:50 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants